[%#
  # IMPORTANT NOTE
  #   This documentation is generated automatically from source
  #   templates.  Any changes you make here may be lost.
  # 
  #   The 'docsrc' documentation source bundle is available for download
  #   from http://www.template-toolkit.org/docs.html and contains all
  #   the source templates, XML files, scripts, etc., from which the
  #   documentation for the Template Toolkit is built.
-%]
[% META book = 'Modules'
        page = 'Stash_XS'
%]
[%  WRAPPER toc;
	PROCESS tocitem 
	        title ="SYNOPSIS"
                subs  = [];
	PROCESS tocitem 
	        title ="DESCRIPTION"
                subs  = [];
	PROCESS tocitem 
	        title ="BUGS"
                subs  = [];
	PROCESS tocitem 
	        title ="AUTHORS"
                subs  = [];
	PROCESS tocitem 
	        title ="VERSION"
                subs  = [];
	PROCESS tocitem 
	        title ="COPYRIGHT"
                subs  = [];
	PROCESS tocitem 
	        title ="SEE ALSO"
                subs  = [];
    END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
    title="SYNOPSIS"
-%]<pre>    use Template;
    use Template::Stash::XS;</pre>
<pre>    my $stash = Template::Stash::XS-&gt;new(\%vars);
    my $tt2   = Template-&gt;new({ STASH =&gt; $stash });</pre>
[%- END %]
[% WRAPPER section
    title="DESCRIPTION"
-%]<p>
The Template:Stash::XS module is an implementation of the
Template::Stash written in C.  The &quot;XS&quot; in the name refers to Perl's
XS extension system for interfacing Perl to C code.  It works just
like the regular Perl implementation of Template::Stash but runs about
twice as fast.
</p>
<p>
The easiest way to use the XS stash is to configure the Template
Toolkit to use it by default.  You can do this at installation time
(when you run <code>'perl Makefile.PL'</code>) by answering 'y' to the questions:
</p>
<pre>    Do you want to build the XS Stash module?      y
    Do you want to use the XS Stash by default?    y</pre>
<p>
See the <file>INSTALL</file> file distributed with the Template Toolkit for further
details on installation.
</p>
<p>
If you don't elect to use the XS stash by default then you should use
the <code>'STASH'</code> configuration item when you create a new Template object.
This should reference an XS stash object that you have created
manually.
</p>
<pre>    use Template;
    use Template::Stash::XS;</pre>
<pre>    my $stash = Template::Stash::XS-&gt;new(\%vars);
    my $tt2   = Template-&gt;new({ STASH =&gt; $stash });</pre>
<p>
Alternately, you can set the <code>'$Template::Config::STASH'</code> package
variable like so:
</p>
<pre>    use Template;
    use Template::Config;</pre>
<pre>    $Template::Config::STASH = 'Template::Stash::XS';</pre>
<pre>    my $tt2 = Template-&gt;new();</pre>
<p>
The XS stash will then be automatically used.  
</p>
<p>
If you want to use the XS stash by default and don't want to
re-install the Template Toolkit, then you can manually modify the
<code>'Template/Config.pm'</code> module near line 42 to read:
</p>
<pre>    $STASH = 'Template::Stash::XS';</pre>
[%- END %]
[% WRAPPER section
    title="BUGS"
-%]<p>
Please report bugs to the Template Toolkit mailing list
templates@template-toolkit.org
</p>
[%- END %]
[% WRAPPER section
    title="AUTHORS"
-%]<p>
Andy Wardley &lt;abw@tt2.org&gt;
</p>
<p>
Doug Steinwand &lt;dsteinwand@citysearch.com&gt;
</p>
[%- END %]
[% WRAPPER section
    title="VERSION"
-%]<p>
Template Toolkit version 2.19, released on 27 April 2007.
</p>
[%- END %]
[% WRAPPER section
    title="COPYRIGHT"
-%]<pre>  Copyright (C) 1996-2007 Andy Wardley.  All Rights Reserved.</pre>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
    title="SEE ALSO"
-%]<p>
[% ttlink('Template::Stash', 'Template::Stash') -%]
</p>
[%- END %]



